<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Home</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Home</h1>

    



    


    <h3> </h3>










    




    <section>
        <article><h2>新德汇前端基础框架（XDH-WEB v3.x）</h2>
<p>基于Vue + ElementUI 的web项目工程框架，专注于公检法行业中台系统快速搭建，框架已在多个项目实战检验。</p>
<p>特色：搭配代码生成器，可生成api调用、vuex管理、模拟数据代码；</p>
<p>内置常用超过70个组件、扩展；子模块支持前端微服务，可以批量编译打包；独立开发、运行、部署；支持更新升级。</p>
<h3>安装</h3>
<pre class="prettyprint source lang-bash"><code>git clone https://gitee.com/newgateway/xdh-web.git
npm run install
</code></pre>
<p>注意：码云上的依赖只支持node 8.x， 如果版本不符合可以用 npm install 安装</p>
<p>安装完依赖，需要初始化项目，运行以下命令</p>
<pre class="prettyprint source lang-bash"><code>npm run init
</code></pre>
<p>项目初始化完成，就可以用 npm run dev 愉快的进入开发模式了，又或者用 npm run dev:docs 打开文档。</p>
<h3>命令说明</h3>
<h4>启动开发环境</h4>
<pre class="prettyprint source lang-bash"><code>npm run dev  或 npm run serve
</code></pre>
<p>两者区别：dev 预设了启动服务自动打开浏览器，即 npm run dev 等价于 npm run serve -- --open</p>
<h4>生产环境编译打包</h4>
<pre class="prettyprint source lang-bash"><code>npm run build
</code></pre>
<h4>整体编译打包，包含主应用和全部子应用</h4>
<pre class="prettyprint source lang-bash"><code>npm run release
</code></pre>
<p>该命令等价于 npm run fix &amp;&amp; build:libs &amp;&amp; npm run coder &amp;&amp; npm run build &amp;&amp; npm run app -- --build</p>
<h4>运行代码质量检查</h4>
<pre class="prettyprint source lang-bash"><code>npm run lint
</code></pre>
<h4>运行单元测试</h4>
<pre class="prettyprint source lang-bash"><code>npm run test:unit
</code></pre>
<h4>运行代码生成器</h4>
<pre class="prettyprint source lang-bash"><code>npm run coder
</code></pre>
<h4>安装依赖模块</h4>
<pre class="prettyprint source lang-bash"><code>npm run install
</code></pre>
<p>建议用 npm run install 从码云拉取</p>
<h4>升级框架</h4>
<pre class="prettyprint source lang-bash"><code>npm run upgrade
</code></pre>
<p>注意：xdh-web v2.x 不支持直接升级到v3.x， 需要使用手动升级脚本</p>
<h4>启动文档http服务</h4>
<pre class="prettyprint source lang-bash"><code>npm run server:docs
</code></pre>
<h4>启动预览打包后的站点http服务</h4>
<pre class="prettyprint source lang-bash"><code>npm run server:dist
</code></pre>
<h4>预编译公共类库、主题</h4>
<pre class="prettyprint source lang-bash"><code>npm run build:libs
</code></pre>
<p>如果element-ui 主题scss配置修改了，需要执行该命令重新生成文件</p>
<h4>启动文档开发环境服务</h4>
<pre class="prettyprint source lang-bash"><code>npm run dev:docs
</code></pre>
<h4>编译打包文档站点</h4>
<pre class="prettyprint source lang-bash"><code>npm run build:docs
</code></pre>
<p>由于开发环境docs占用系统资源，可以编译后，用 npm run server:docs 来预览文档</p>
<h4>生成注释帮助文档</h4>
<pre class="prettyprint source lang-bash"><code>npm run jsdoc
</code></pre>
<p>生成的文档集成在docs，可以用 npm run dev:docs 或 npm run server:docs 预览</p>
<h4>修复node_modules 类库的bug</h4>
<pre class="prettyprint source lang-bash"><code>npm run fix
</code></pre>
<p>修复 element-ui / axios / gojs</p>
<h3>站点应用管理命令</h3>
<p>框架支持多站点或目录分离打包，以满足编译非全局模块的快速响应需求。</p>
<h4>新增站点</h4>
<pre class="prettyprint source lang-bash"><code>npm run app -- --add [name] --port [port] --url [baseUrl] --out [outputDir]
</code></pre>
<ul>
<li>name： 站点名称，必填，</li>
<li>port： 开发环境启动端口号，可选，默认：8001</li>
<li>url:   网站部署目录路径，可选，默认: 与name相等</li>
<li>out:   打包输出目录，依赖 config.outputDir， 可选，默认: 与name相等</li>
</ul>
<h5>示例</h5>
<pre class="prettyprint source lang-bash"><code>npm run app -- --add myApp --port 12345 --url /topic --out /topic
</code></pre>
<p>注意：url 和 out 参数必须以 &quot;/&quot; 开始， 不能用相对路径, 建议 url 和 out 用相同的值，除非你清楚怎么部署。</p>
<h4>删除站点</h4>
<pre class="prettyprint source lang-bash"><code>npm run app -- --remove [name]
</code></pre>
<p>name： 站点名称，必填，</p>
<h5>示例</h5>
<pre class="prettyprint source lang-bash"><code>npm run app -- --remove myApp
</code></pre>
<h4>批量编译打包全部站点</h4>
<pre class="prettyprint source lang-bash"><code>npm run app -- --build
</code></pre>
<h3>自动持续集成辅助命令</h3>
<pre class="prettyprint source lang-bash"><code>node bin -c [config] -a [app] -o [out] -u [url]
</code></pre>
<p>在与 jenkins 集成时，可以利用命令执行编译打包。参数：</p>
<ul>
<li>config 配置文件路径，可选，默认取：/public/config.js</li>
<li>app 需要编译的子应用名称，可选，默认打包主应用</li>
<li>out 打包输入目录，可选，默认 /dist</li>
<li>url baseUrl，可选，默认取配置文件</li>
</ul></article>
    </section>






</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-base_api_user.html">base/api/user</a></li><li><a href="module-base_mixin_user.html">base/mixin/user</a></li><li><a href="module-base_types.html">base/types</a></li><li><a href="module-mapping_index.html">mapping/index</a></li><li><a href="module-mock_templates.html">mock/templates</a></li><li><a href="module-router_index.html">router/index</a></li><li><a href="module-store_getters.html">store/getters</a></li><li><a href="module-store_index.html">store/index</a></li><li><a href="module-store_mutations.html">store/mutations</a></li><li><a href="module-store_state.html">store/state</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Tue May 12 2020 16:50:37 GMT+0800 (GMT+08:00)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>